Esx Settings Clusters Vms Solutions DeploymentInfo
The Esx Settings Clusters Vms Solutions DeploymentInfo schema contains properties that describe the state of a single VM deployment of a solution.
This schema was added in vSphere API 9.0.0.0.
{
"status": "string",
"vm": "string",
"replacement_vm": "string",
"issues": [
{
"type": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
}
}
],
"lifecycle_hook": {
"vm": "string",
"lifecycle_state": "string",
"configuration": {
"timeout": 0
},
"hook_activated": "string"
},
"solution_info": {
"deployment_type": "string",
"display_name": "string",
"display_version": "string",
"vm_name_template": {
"prefix": "string",
"suffix": "string"
},
"host_solution_info": {
"prefer_host_configuration": false,
"vm_networks": [
"string"
],
"vm_datastores": [
"string"
]
},
"cluster_solution_info": {
"vm_count": 0,
"vm_placement_policies": [
"string"
],
"vm_networks": {
"vm_networks": "string"
},
"vm_datastores": [
"string"
],
"devices": {}
},
"hook_configurations": {
"hook_configurations": {
"timeout": 0
}
},
"ovf_resource": {
"location_type": "string",
"url": "string",
"ssl_certificate_validation": "string",
"certificate": "string"
},
"ovf_descriptor_properties": {
"ovf_descriptor_properties": "string"
},
"vm_clone_config": "string",
"vm_storage_policy": "string",
"vm_storage_profiles": [
"string"
],
"vm_disk_type": "string",
"vm_resource_pool": "string",
"vm_folder": "string",
"vm_resource_spec": {
"ovf_deployment_option": "string"
}
}
}Compliance status of the deployment.
For more information see: Esx Settings Clusters Vms Solutions DeploymentInfo Status.
This property was added in vSphere API 9.0.0.0.
Identifier of the currently deployed VM. More information about the runtime state of the VM can be observed through the VIM API.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if:
- The VM deployment is not started yet.
- There are issues specified by the issues that prevents the VM to be deployed.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.
Identifier of the VM that is going to replace the current deployed VM. More information about the runtime state of the VM can be observed through the VIM API.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if there is no ongoing VM upgrade for the current VM deployment.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.
List of Esx Settings Clusters Vms Solutions IssueInfo which do not allow the deployment to reach the desired specification specified by the solution_info. In order to remediate these issues an apply operation POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply need to be initiated.
This property was added in vSphere API 9.0.0.0.
The activated VM lifecycle hook for the VM specified by the vm that the system is waiting to be processed by the solution in order to continue attempting to reach the desired specification.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if there is no activated hook for the VM.
Describes the current desired solution specification of the deployment.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of status is one of Esx Settings Clusters Vms Solutions DeploymentInfo Status.IN_PROGRESS, Esx Settings Clusters Vms Solutions DeploymentInfo Status.COMPLIANT, Esx Settings Clusters Vms Solutions DeploymentInfo Status.ISSUE, Esx Settings Clusters Vms Solutions DeploymentInfo Status.IN_LIFECYCLE_HOOK, or Esx Settings Clusters Vms Solutions DeploymentInfo Status.OBSOLETE_SPEC.